home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / chat.arc / CHAT.DOC next >
Encoding:
Text File  |  1988-04-13  |  7.2 KB  |  157 lines
  1. CHAT                    (Current Version 1.03b)
  2. By: Tom Evans
  3. Jax C-Scape             (Opus 1:112/1027.0)     (904) 724-1377
  4.              Specializing In Custom Opus Utility Software
  5.                                 and
  6.                         Custom C Programming
  7.  
  8.                     Documentation For CHAT Program
  9.  
  10.         The CHAT program is a utility program for OPUS bulletin board
  11. systems that will allow your users that use ansi graphics to chat with
  12. you in a split screen mode with the text that the sysop types on the 
  13. bottom, and the text that the user types on the top.  It also allows
  14. for both parties to talk at the same time.
  15.  
  16.         Unlike previous versions of this program, version 1.02f and above
  17. does check whether or not the user has ansi graphics enabled. If they do
  18. not, and you allow the chat, they will see a normal chat without any ansi
  19. graphics, while you will see the screen as normal.
  20.  
  21.         I will explain how to install this program as part of your OPUS
  22. board, but first, I would like to explain the parameters that CHAT uses
  23. on the command line when activated.
  24.  
  25.         The first and second parameter on the command line are reserved
  26. for the sysop's name.  These are the only required parameters.  Actually,
  27. they are not even required.  If they are not supplied, then CHAT, instead
  28. of displaying the sysop's name in the lower window, will display "Sysop".
  29. One word to note here.  It does not matter if you put your name in all
  30. caps or all lower case letters, or however you want.  When activated, CHAT
  31. will automatically convert all of the characters to lower case, except the
  32. first character of each part of the name.  For example:
  33.         CHAT tom evans
  34. Will display the sysop's name as Tom Evans.
  35.  
  36.         The third (and later) parameter is optional.  There are a number 
  37. of things you can put in the third parameter position.  
  38.  
  39.         The first is the port number. CHAT defaults to using COM1 as the 
  40. communications port.  This may be changed with the third parameter.  
  41. Specifying 1 for this will default to COM1, 2 will use COM2, and so on.
  42.  
  43.          The second thing you may specify for the third parameter is
  44. for those sysops who wish to use the CHAT program when they want to chat
  45. with a user.  This is normally accomplished using the opus "c" command 
  46. when the user is at a menu.  If you use AUTOCHAT as the third paramater, then
  47. CHAT will start up and go directly into the chat mode.  This will alleviate
  48. CHAT from paging the sysop when it is the sysop who is requesting the chat.
  49.  
  50.         The third thing you may specify for the third parameter are the
  51. hours for which CHAT will be avaliable.  You may only specify one start time
  52. and one stop time.  For instance, you may want to turn chat on at 11:00 am,
  53. and off at 10:30 pm.
  54.  
  55.         If you specify either AUTOCHAT or the availablilty time for CHAT as
  56. the third parameter, then you may also still specify the com port number that
  57. you would like to use by putting the communications port number as the fourth
  58. parameter instead of the third.
  59.  
  60. Some examples of use:
  61.         To start CHAT on com2 (user invoked):
  62.         CHAT tom evans 2
  63.  
  64.         To start CHAT on default com port of com1 (sysop invoked):
  65.         CHAT tom evans AUTOCHAT
  66.  
  67.         To start CHAT on com2 (sysop invoked):
  68.         CHAT tom evans AUTOCHAT 2
  69.  
  70.         To make CHAT available only from 11:15 am to 10:35 pm on com1
  71.         (user invoked): [Note the 24 hour format for the start/stop time]
  72.         CHAT tom evans 1115/2235
  73.  
  74.         Same as above only using com2:
  75.         CHAT tom evans 1115/2235 2
  76.  
  77.         You may not specify AUTOCHAT with a time value, but this is
  78. irrelevant, since if the sysop is initiating the chat, then there needs to
  79. be no start/stop time.
  80.  
  81. INSTALLATION NOTES:
  82.         There are many ways to install this program with opus.  I will
  83. discuss each one of them briefly.
  84.  
  85.         To install CHAT as a sysop invoked program to chat with a user,
  86. you may use one of the Function keys on your keyboard to activate CHAT.
  87. If for example, you wanted F6 to invoke the CHAT program, then you would
  88. create an F6.BBS file with the following line in it:
  89. (Note that ^O is control-O)
  90.         ^OCc:\opus\chat tom evans AUTOCHAT
  91.  
  92.         To install CHAT as a user invoked program to chat with the sysop, 
  93. while retaining the normal OPUS Y)ell at sysop function, you could put the
  94. following line in your bulletin.bbs file if a user selects a particular 
  95. choice from your bulletin menu:
  96.         ^OCc:\opus\chat tom evans 1115/2235 2
  97.  
  98.         To install CHAT in place of the OPUS Y)ell at sysop menu selection
  99. at the MAIN MENU, you can use a program such as OPRIV to edit your mainpriv
  100. file to change the Y)ell at sysop selection to something else and making the
  101. menu selection hidden.  For instance, change "Y)ell at sysop" to
  102. "Z)ell at sysop" and make this selection "hidden".  This will keep the normal
  103. OPUS chat routine from running when the user types "y" at the MAIN MENU.  Now,
  104. to install CHAT into the MAIN MENU, you can change the "O)utside" selection or
  105. the "E)ditorial" selection to be "Y)ell at Sysop".  If you use the "O)utside"
  106. approach, then in your OPUS.CTL file, you will need to change the line
  107. which selects the program to run as an OUTSIDE program.  First, comment out
  108. (place a "%" in front of the line) the:
  109.  
  110. Uses Outside  c:\opus\misc\leaving
  111.  
  112. Also, comment out the line:
  113.  
  114. Uses Return c:\opus\misc\return
  115.  
  116. Then, remove the comment from the "outside dos" line to read:
  117.  
  118. Outside Dos c:\opus\chat tom evans
  119.  
  120.  
  121.         Advanced users will note that you could make one selection activate
  122. CHAT with a time specification on it for normal users, and make another
  123. CHAT available as the normal OPUS chat routine for your special users.
  124. This will allow normal users to page during certain hours only, but will 
  125. allow users with higher privilege levels to chat with you at any time.
  126.  
  127.         One final note.  As with all my programs, there is no warranty.
  128. Especially since this version is not even a public release version.  The
  129. program has been tested on a few systems however, and no known bugs exist.
  130. If you do however, find an undocumented "feature" of this program, please
  131. send mail to me at my board noted at the beginning of this document describing
  132. the problem.  I will more than likely make repairs immediately.
  133.  
  134. Revision Notes:
  135.     1.03a   Added some minor improvements to chat for testing (paving
  136.             the way for version 2.0).  Improved Clear Window speed.
  137.  
  138.     1.03b   Fixed infamous bug which may have caused problems on
  139.             ports other than COM1.
  140.  
  141.  
  142.  
  143. Future Expansion:
  144.         1.)  Use the OPUS schedule file for the chat times instead of 
  145.              specifying them on the command line.
  146.  
  147.         2.)  Read the OPUS.PRM file for things like the sysop's name, and
  148.              the COM port that is being used.
  149.  
  150. Done    3.)  Make a check for users who do not have ansi graphics enabled
  151.              or do not have an 80x24 screen, and make the program go into
  152.              a line mode chat, similar to the current OPUS 1.03a version
  153.              chat mode.
  154.  
  155.         If you can think of any other expansions or changes that you would
  156. like to see, just drop me a line, and I will see what I can do. 
  157.